* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
- * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
-#include "gtkcheckbuttonprivate.h"
-
-#include "gtkbuttonprivate.h"
-#include "gtklabel.h"
-
-#include "gtkintl.h"
-#include "gtkprivate.h"
-#include "gtkwidgetprivate.h"
+#include "gtkactionhelperprivate.h"
+#include "gtkboxlayout.h"
+#include "gtkbuiltiniconprivate.h"
#include "gtkcssnodeprivate.h"
-#include "gtkstylecontextprivate.h"
#include "gtkcssnumbervalueprivate.h"
+#include "gtkgestureclick.h"
+#include "gtkintl.h"
+#include "gtklabel.h"
+#include "gtkprivate.h"
#include "gtkradiobutton.h"
-#include "gtkbuiltiniconprivate.h"
-#include "gtkboxlayout.h"
-
+#include "gtkstylecontextprivate.h"
+#include "gtkwidgetprivate.h"
/**
* SECTION:gtkcheckbutton
* @Title: GtkCheckButton
* @See_also: #GtkButton, #GtkToggleButton, #GtkRadioButton
*
- * A #GtkCheckButton places a discrete #GtkToggleButton next to a widget,
- * (usually a #GtkLabel). See the section on #GtkToggleButton widgets for
- * more information about toggle/check buttons.
- *
- * The important signal ( #GtkToggleButton::toggled ) is also inherited from
- * #GtkToggleButton.
+ * A #GtkCheckButton places a label next to an indicator.
*
* # CSS nodes
*
* |[<!-- language="plain" -->
- * checkbutton
- * ├── check
- * ╰── <child>
- * ]|
- *
- * A GtkCheckButton with indicator (see gtk_check_button_set_draw_indicator()) has a
- * main CSS node with name checkbutton and a subnode with name check.
- *
- * |[<!-- language="plain" -->
- * button.check
+ * checkbutton[.text-button]
* ├── check
- * ╰── <child>
+ * ╰── [label]
* ]|
*
- * A GtkCheckButton without indicator changes the name of its main node
- * to button and adds a .check style class to it. The subnode is invisible
- * in this case.
+ * A #GtkCheckButton has a main node with name checkbutton. If the
+ * #GtkCheckButton:label property is set, it contains a label child.
+ * The indicator node is named check when no group is set, and radio
+ * if the checkbutton is grouped together with other checkbuttons.
*
* # Accessibility
*
typedef struct {
GtkWidget *indicator_widget;
+ GtkWidget *label_widget;
+
+ guint inconsistent: 1;
+ guint active: 1;
+ guint use_underline: 1;
+
+ GtkCheckButton *group_next;
+ GtkCheckButton *group_prev;
- guint draw_indicator : 1;
- guint inconsistent : 1;
+ GtkActionHelper *action_helper;
} GtkCheckButtonPrivate;
enum {
PROP_0,
- PROP_DRAW_INDICATOR,
+ PROP_ACTIVE,
+ PROP_GROUP,
+ PROP_LABEL,
PROP_INCONSISTENT,
- NUM_PROPERTIES
+ PROP_USE_UNDERLINE,
+
+ /* actionable properties */
+ PROP_ACTION_NAME,
+ PROP_ACTION_TARGET,
+ LAST_PROP = PROP_ACTION_NAME
};
-static GParamSpec *props[NUM_PROPERTIES] = { NULL, };
+enum {
+ TOGGLED,
+ LAST_SIGNAL
+};
-G_DEFINE_TYPE_WITH_PRIVATE (GtkCheckButton, gtk_check_button, GTK_TYPE_TOGGLE_BUTTON)
+static void gtk_check_button_actionable_iface_init (GtkActionableInterface *iface);
+static guint signals[LAST_SIGNAL] = { 0 };
+static GParamSpec *props[LAST_PROP] = { NULL, };
+
+G_DEFINE_TYPE_WITH_CODE (GtkCheckButton, gtk_check_button, GTK_TYPE_WIDGET,
+ G_ADD_PRIVATE (GtkCheckButton)
+ G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIONABLE, gtk_check_button_actionable_iface_init))
static void
-gtk_check_button_update_node_state (GtkWidget *widget)
+gtk_check_button_dispose (GObject *object)
{
- GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (GTK_CHECK_BUTTON (widget));
- GtkStateFlags state;
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (GTK_CHECK_BUTTON (object));
- if (!priv->indicator_widget)
- return;
+ g_clear_pointer (&priv->indicator_widget, gtk_widget_unparent);
+ g_clear_pointer (&priv->label_widget, gtk_widget_unparent);
- state = gtk_widget_get_state_flags (widget);
+ gtk_check_button_set_group (GTK_CHECK_BUTTON (object), NULL);
- gtk_widget_set_state_flags (priv->indicator_widget, state, TRUE);
+ G_OBJECT_CLASS (gtk_check_button_parent_class)->dispose (object);
}
-
static void
-gtk_check_button_state_flags_changed (GtkWidget *widget,
- GtkStateFlags previous_state_flags)
+gtk_check_button_set_action_name (GtkActionable *actionable,
+ const char *action_name)
{
- gtk_check_button_update_node_state (widget);
+ GtkCheckButton *self = GTK_CHECK_BUTTON (actionable);
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
- GTK_WIDGET_CLASS (gtk_check_button_parent_class)->state_flags_changed (widget, previous_state_flags);
+ if (!priv->action_helper)
+ priv->action_helper = gtk_action_helper_new (actionable);
+
+ gtk_action_helper_set_action_name (priv->action_helper, action_name);
}
static void
-gtk_check_button_finalize (GObject *object)
+gtk_check_button_set_action_target_value (GtkActionable *actionable,
+ GVariant *action_target)
{
- GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (GTK_CHECK_BUTTON (object));
+ GtkCheckButton *self = GTK_CHECK_BUTTON (actionable);
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
- g_clear_pointer (&priv->indicator_widget, gtk_widget_unparent);
+ if (!priv->action_helper)
+ priv->action_helper = gtk_action_helper_new (actionable);
- G_OBJECT_CLASS (gtk_check_button_parent_class)->finalize (object);
+ gtk_action_helper_set_action_target_value (priv->action_helper, action_target);
}
static void
{
switch (prop_id)
{
- case PROP_DRAW_INDICATOR:
- gtk_check_button_set_draw_indicator (GTK_CHECK_BUTTON (object),
- g_value_get_boolean (value));
-
+ case PROP_ACTIVE:
+ gtk_check_button_set_active (GTK_CHECK_BUTTON (object), g_value_get_boolean (value));
+ break;
+ case PROP_GROUP:
+ gtk_check_button_set_group (GTK_CHECK_BUTTON (object), g_value_get_object (value));
+ break;
+ case PROP_LABEL:
+ gtk_check_button_set_label (GTK_CHECK_BUTTON (object), g_value_get_string (value));
+ break;
+ case PROP_INCONSISTENT:
+ gtk_check_button_set_inconsistent (GTK_CHECK_BUTTON (object), g_value_get_boolean (value));
break;
- case PROP_INCONSISTENT:
- gtk_check_button_set_inconsistent (GTK_CHECK_BUTTON (object),
- g_value_get_boolean (value));
+ case PROP_USE_UNDERLINE:
+ gtk_check_button_set_use_underline (GTK_CHECK_BUTTON (object), g_value_get_boolean (value));
break;
- default:
+ case PROP_ACTION_NAME:
+ gtk_check_button_set_action_name (GTK_ACTIONABLE (object), g_value_get_string (value));
+ break;
+ case PROP_ACTION_TARGET:
+ gtk_check_button_set_action_target_value (GTK_ACTIONABLE (object), g_value_get_variant (value));
+ break;
+ default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
-gtk_check_button_get_property (GObject *object,
- guint prop_id,
- GValue *value,
- GParamSpec *pspec)
+gtk_check_button_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
{
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (GTK_CHECK_BUTTON (object));
+
switch (prop_id)
{
- case PROP_DRAW_INDICATOR:
- g_value_set_boolean (value, gtk_check_button_get_draw_indicator (GTK_CHECK_BUTTON (object)));
+ case PROP_ACTIVE:
+ g_value_set_boolean (value, gtk_check_button_get_active (GTK_CHECK_BUTTON (object)));
+ break;
+ case PROP_LABEL:
+ g_value_set_string (value, gtk_check_button_get_label (GTK_CHECK_BUTTON (object)));
+ break;
+ case PROP_INCONSISTENT:
+ g_value_set_boolean (value, gtk_check_button_get_inconsistent (GTK_CHECK_BUTTON (object)));
+ break;
+ case PROP_USE_UNDERLINE:
+ g_value_set_boolean (value, gtk_check_button_get_use_underline (GTK_CHECK_BUTTON (object)));
+ break;
+ case PROP_ACTION_NAME:
+ g_value_set_string (value, gtk_action_helper_get_action_name (priv->action_helper));
break;
- case PROP_INCONSISTENT:
- g_value_set_boolean (value, gtk_check_button_get_inconsistent (GTK_CHECK_BUTTON (object)));
+ case PROP_ACTION_TARGET:
+ g_value_set_variant (value, gtk_action_helper_get_action_target_value (priv->action_helper));
break;
- default:
+ default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
+static const char *
+gtk_check_button_get_action_name (GtkActionable *actionable)
+{
+ GtkCheckButton *self = GTK_CHECK_BUTTON (actionable);
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+
+ return gtk_action_helper_get_action_name (priv->action_helper);
+}
+
+static GVariant *
+gtk_check_button_get_action_target_value (GtkActionable *actionable)
+{
+ GtkCheckButton *self = GTK_CHECK_BUTTON (actionable);
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+
+ return gtk_action_helper_get_action_target_value (priv->action_helper);
+}
+
+static void
+gtk_check_button_actionable_iface_init (GtkActionableInterface *iface)
+{
+ iface->get_action_name = gtk_check_button_get_action_name;
+ iface->set_action_name = gtk_check_button_set_action_name;
+ iface->get_action_target_value = gtk_check_button_get_action_target_value;
+ iface->set_action_target_value = gtk_check_button_set_action_target_value;
+}
+
+static void
+click_pressed_cb (GtkGestureClick *gesture,
+ guint n_press,
+ double x,
+ double y,
+ GtkWidget *widget)
+{
+ if (gtk_widget_get_focus_on_click (widget) && !gtk_widget_has_focus (widget))
+ gtk_widget_grab_focus (widget);
+
+ gtk_gesture_set_state (GTK_GESTURE (gesture), GTK_EVENT_SEQUENCE_CLAIMED);
+}
+
+static void
+click_released_cb (GtkGestureClick *gesture,
+ guint n_press,
+ double x,
+ double y,
+ GtkWidget *widget)
+{
+ GtkCheckButton *self = GTK_CHECK_BUTTON (widget);
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+
+ if (priv->active && priv->group_prev)
+ return;
+
+ gtk_check_button_set_active (self, !priv->active);
+
+ if (priv->action_helper)
+ gtk_action_helper_activate (priv->action_helper);
+}
+
static void
update_accessible_state (GtkCheckButton *check_button)
{
if (priv->inconsistent)
checked_state = GTK_ACCESSIBLE_TRISTATE_MIXED;
- else if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (check_button)))
+ else if (priv->active)
checked_state = GTK_ACCESSIBLE_TRISTATE_TRUE;
else
checked_state = GTK_ACCESSIBLE_TRISTATE_FALSE;
-1);
}
-static void
-gtk_check_button_notify (GObject *object,
- GParamSpec *pspec)
+
+static GtkCheckButton *
+get_group_next (GtkCheckButton *self)
{
- if (pspec->name == I_("active"))
- update_accessible_state (GTK_CHECK_BUTTON (object));
+ return ((GtkCheckButtonPrivate *)gtk_check_button_get_instance_private (self))->group_next;
+}
- if (G_OBJECT_CLASS (gtk_check_button_parent_class)->notify)
- G_OBJECT_CLASS (gtk_check_button_parent_class)->notify (object, pspec);
+static GtkCheckButton *
+get_group_prev (GtkCheckButton *self)
+{
+ return ((GtkCheckButtonPrivate *)gtk_check_button_get_instance_private (self))->group_prev;
}
-static void
-gtk_check_button_class_init (GtkCheckButtonClass *class)
+static GtkCheckButton *
+get_group_first (GtkCheckButton *self)
{
- GObjectClass *object_class = G_OBJECT_CLASS (class);
- GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
+ GtkCheckButton *group_first = NULL;
+ GtkCheckButton *iter;
- object_class->notify = gtk_check_button_notify;
- object_class->finalize = gtk_check_button_finalize;
- object_class->set_property = gtk_check_button_set_property;
- object_class->get_property = gtk_check_button_get_property;
+ /* Find first in group */
+ iter = self;
+ while (iter)
+ {
+ group_first = iter;
- widget_class->state_flags_changed = gtk_check_button_state_flags_changed;
+ iter = get_group_prev (iter);
+ if (!iter)
+ break;
+ }
- props[PROP_DRAW_INDICATOR] =
- g_param_spec_boolean ("draw-indicator",
- P_("Draw Indicator"),
- P_("If the indicator part of the button is displayed"),
- TRUE,
- GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
+ g_assert (group_first);
- props[PROP_INCONSISTENT] =
- g_param_spec_boolean ("inconsistent",
- P_("Inconsistent"),
- P_("If the check button is in an “in between” state"),
- FALSE,
- GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
+ return group_first;
+}
- g_object_class_install_properties (object_class, NUM_PROPERTIES, props);
+static GtkCheckButton *
+get_group_active_button (GtkCheckButton *self)
+{
+ GtkCheckButton *iter;
- gtk_widget_class_set_layout_manager_type (widget_class, GTK_TYPE_BOX_LAYOUT);
- gtk_widget_class_set_css_name (widget_class, I_("checkbutton"));
- gtk_widget_class_set_accessible_role (widget_class, GTK_ACCESSIBLE_ROLE_CHECKBOX);
+ for (iter = get_group_first (self); iter; iter = get_group_next (iter))
+ {
+ if (gtk_check_button_get_active (iter))
+ return iter;
+ }
+
+ return NULL;
}
-static void
-draw_indicator_changed (GtkCheckButton *check_button)
+static gboolean
+gtk_check_button_focus (GtkWidget *widget,
+ GtkDirectionType direction)
{
- GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (check_button);
- GtkCssNode *widget_node;
+ GtkCheckButton *self = GTK_CHECK_BUTTON (widget);
+ GtkCheckButton *active_button;
- widget_node = gtk_widget_get_css_node (GTK_WIDGET (check_button));
+ active_button = get_group_active_button (self);
- if (priv->draw_indicator)
+ if (gtk_widget_is_focus (widget))
{
- priv->indicator_widget = gtk_builtin_icon_new ("check");
- gtk_widget_set_halign (priv->indicator_widget, GTK_ALIGN_CENTER);
- gtk_widget_set_valign (priv->indicator_widget, GTK_ALIGN_CENTER);
- gtk_widget_set_parent (priv->indicator_widget, GTK_WIDGET (check_button));
- if (GTK_IS_RADIO_BUTTON (check_button))
+ GtkCheckButton *iter;
+ GPtrArray *child_array;
+ GtkWidget *new_focus = NULL;
+ guint index;
+ gboolean found;
+ guint i;
+
+ if (direction == GTK_DIR_TAB_FORWARD ||
+ direction == GTK_DIR_TAB_BACKWARD)
+ return FALSE;
+
+ child_array = g_ptr_array_new ();
+ for (iter = get_group_first (self); iter; iter = get_group_next (iter))
+ g_ptr_array_add (child_array, iter);
+
+ gtk_widget_focus_sort (widget, direction, child_array);
+ found = g_ptr_array_find (child_array, widget, &index);
+
+ if (found)
{
- gtk_css_node_remove_class (widget_node, g_quark_from_static_string ("radio"));
- gtk_css_node_set_name (widget_node, g_quark_from_static_string ("radiobutton"));
+ /* Start at the *next* widget in the list */
+ if (index < child_array->len - 1)
+ index ++;
}
- else if (GTK_IS_CHECK_BUTTON (check_button))
+ else
{
- gtk_css_node_remove_class (widget_node, g_quark_from_static_string ("check"));
- gtk_css_node_set_name (widget_node, g_quark_from_static_string ("checkbutton"));
+ /* Search from the start of the list */
+ index = 0;
}
- }
- else
- {
- gtk_widget_unparent (priv->indicator_widget);
- priv->indicator_widget = NULL;
- if (GTK_IS_RADIO_BUTTON (check_button))
+
+ for (i = index; i < child_array->len; i ++)
{
- gtk_css_node_add_class (widget_node, g_quark_from_static_string ("radio"));
- gtk_css_node_set_name (widget_node, g_quark_from_static_string ("button"));
+ GtkWidget *child = g_ptr_array_index (child_array, i);
+
+ if (gtk_widget_get_mapped (child) && gtk_widget_is_sensitive (child))
+ {
+ new_focus = child;
+ break;
+ }
}
- else if (GTK_IS_CHECK_BUTTON (check_button))
+
+
+ if (new_focus)
{
- gtk_css_node_add_class (widget_node, g_quark_from_static_string ("check"));
- gtk_css_node_set_name (widget_node, g_quark_from_static_string ("button"));
+ gtk_widget_grab_focus (new_focus);
+ gtk_check_button_set_active (GTK_CHECK_BUTTON (new_focus), TRUE);
+ if (active_button && active_button != (GtkCheckButton *)new_focus)
+ gtk_check_button_set_active (GTK_CHECK_BUTTON (active_button), FALSE);
}
+
+ g_ptr_array_free (child_array, TRUE);
+
+ return TRUE;
+ }
+ else
+ {
+ if (active_button && active_button != self)
+ return FALSE;
+
+ gtk_widget_grab_focus (widget);
+ return TRUE;
}
}
static void
-gtk_check_button_init (GtkCheckButton *check_button)
+gtk_check_button_class_init (GtkCheckButtonClass *class)
{
- GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (check_button);
+ GObjectClass *object_class = G_OBJECT_CLASS (class);
+ GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
+
+ object_class->dispose = gtk_check_button_dispose;
+ object_class->set_property = gtk_check_button_set_property;
+ object_class->get_property = gtk_check_button_get_property;
- gtk_widget_set_receives_default (GTK_WIDGET (check_button), FALSE);
+ widget_class->focus = gtk_check_button_focus;
- gtk_widget_remove_css_class (GTK_WIDGET (check_button), "toggle");
+ props[PROP_ACTIVE] =
+ g_param_spec_boolean ("active",
+ P_("Active"),
+ P_("If the toggle button should be pressed in"),
+ FALSE,
+ GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
+ props[PROP_GROUP] =
+ g_param_spec_object ("group",
+ P_("Group"),
+ P_("The check button whose group this widget belongs to."),
+ GTK_TYPE_CHECK_BUTTON,
+ GTK_PARAM_WRITABLE);
+ props[PROP_LABEL] =
+ g_param_spec_string ("label",
+ P_("Label"),
+ P_("Text of the label widget inside the button, if the button contains a label widget"),
+ NULL,
+ GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
+
+ props[PROP_INCONSISTENT] =
+ g_param_spec_boolean ("inconsistent",
+ P_("Inconsistent"),
+ P_("If the check button is in an “in between” state"),
+ FALSE,
+ GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
- priv->draw_indicator = TRUE;
- draw_indicator_changed (check_button);
- gtk_check_button_update_node_state (GTK_WIDGET (check_button));
- update_accessible_state (check_button);
+ props[PROP_USE_UNDERLINE] =
+ g_param_spec_boolean ("use-underline",
+ P_("Use underline"),
+ P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
+ FALSE,
+ GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
+
+ g_object_class_install_properties (object_class, LAST_PROP, props);
+
+ g_object_class_override_property (object_class, PROP_ACTION_NAME, "action-name");
+ g_object_class_override_property (object_class, PROP_ACTION_TARGET, "action-target");
+
+
+ /**
+ * GtkCheckButton::toggled:
+ *
+ * Emitted when the buttons's #GtkCheckButton:active flag changes.
+ */
+ signals[TOGGLED] =
+ g_signal_new (I_("toggled"),
+ G_OBJECT_CLASS_TYPE (object_class),
+ G_SIGNAL_RUN_FIRST,
+ G_STRUCT_OFFSET (GtkCheckButtonClass, toggled),
+ NULL, NULL,
+ NULL,
+ G_TYPE_NONE, 0);
+
+ gtk_widget_class_set_layout_manager_type (widget_class, GTK_TYPE_BOX_LAYOUT);
+ gtk_widget_class_set_css_name (widget_class, I_("checkbutton"));
+ gtk_widget_class_set_accessible_role (widget_class, GTK_ACCESSIBLE_ROLE_CHECKBOX);
+}
+
+static void
+gtk_check_button_init (GtkCheckButton *self)
+{
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+ GtkGesture *gesture;
+
+ gtk_widget_set_receives_default (GTK_WIDGET (self), FALSE);
+ priv->indicator_widget = gtk_builtin_icon_new ("check");
+ gtk_widget_set_halign (priv->indicator_widget, GTK_ALIGN_CENTER);
+ gtk_widget_set_valign (priv->indicator_widget, GTK_ALIGN_CENTER);
+ gtk_widget_set_parent (priv->indicator_widget, GTK_WIDGET (self));
+
+ update_accessible_state (self);
+
+ gesture = gtk_gesture_click_new ();
+ gtk_gesture_single_set_touch_only (GTK_GESTURE_SINGLE (gesture), FALSE);
+ gtk_gesture_single_set_exclusive (GTK_GESTURE_SINGLE (gesture), TRUE);
+ gtk_gesture_single_set_button (GTK_GESTURE_SINGLE (gesture), GDK_BUTTON_PRIMARY);
+ g_signal_connect (gesture, "pressed", G_CALLBACK (click_pressed_cb), self);
+ g_signal_connect (gesture, "released", G_CALLBACK (click_released_cb), self);
+ gtk_event_controller_set_propagation_phase (GTK_EVENT_CONTROLLER (gesture), GTK_PHASE_CAPTURE);
+ gtk_widget_add_controller (GTK_WIDGET (self), GTK_EVENT_CONTROLLER (gesture));
+
+ gtk_widget_set_focusable (GTK_WIDGET (self), TRUE);
}
/**
*
* Returns: a #GtkWidget.
*/
-GtkWidget*
+GtkWidget *
gtk_check_button_new (void)
{
return g_object_new (GTK_TYPE_CHECK_BUTTON, NULL);
}
-
/**
* gtk_check_button_new_with_label:
- * @label: the text for the check button.
+ * @label: (nullable): the text for the check button.
*
- * Creates a new #GtkCheckButton with a #GtkLabel to the right of it.
+ * Creates a new #GtkCheckButton with a #GtkLabel next to it, if
+ * @label is non-%NULL.
*
- * Returns: a #GtkWidget.
+ * Returns: a new #GtkCheckButton
*/
GtkWidget*
gtk_check_button_new_with_label (const char *label)
/**
* gtk_check_button_new_with_mnemonic:
- * @label: The text of the button, with an underscore in front of the
+ * @label: (nullable): The text of the button, with an underscore in front of the
* mnemonic character
*
- * Creates a new #GtkCheckButton containing a label. The label
- * will be created using gtk_label_new_with_mnemonic(), so underscores
+ * Creates a new #GtkCheckButton containing a label. Underscores
* in @label indicate the mnemonic for the check button.
*
* Returns: a new #GtkCheckButton
GtkWidget*
gtk_check_button_new_with_mnemonic (const char *label)
{
- return g_object_new (GTK_TYPE_CHECK_BUTTON,
- "label", label,
- "use-underline", TRUE,
+ return g_object_new (GTK_TYPE_CHECK_BUTTON,
+ "label", label,
+ "use-underline", TRUE,
NULL);
}
-GtkCssNode *
-gtk_check_button_get_indicator_node (GtkCheckButton *check_button)
-{
- GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (check_button);
-
- return gtk_widget_get_css_node (priv->indicator_widget);
-}
-
-/**
- * gtk_check_button_set_draw_indicator:
- * @check_button: a #GtkCheckButton
- * @draw_indicator: Whether or not to draw the indicator part of the button
- *
- * Sets whether the indicator part of the button is drawn. This is important for
- * cases where the check button should have the functionality of a check button,
- * but the visuals of a regular button, like in a #GtkStackSwitcher.
- */
-void
-gtk_check_button_set_draw_indicator (GtkCheckButton *check_button,
- gboolean draw_indicator)
-{
- GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (check_button);
-
- g_return_if_fail (GTK_IS_CHECK_BUTTON (check_button));
-
- draw_indicator = !!draw_indicator;
-
- if (draw_indicator != priv->draw_indicator)
- {
- priv->draw_indicator = draw_indicator;
- draw_indicator_changed (check_button);
- gtk_widget_queue_resize (GTK_WIDGET (check_button));
- g_object_notify_by_pspec (G_OBJECT (check_button), props[PROP_DRAW_INDICATOR]);
- }
-}
-
-/**
- * gtk_check_button_get_draw_indicator:
- * @check_button: a #GtkCheckButton
- *
- * Returns Whether or not the indicator part of the button gets drawn.
- *
- * Returns: The value of the GtkCheckButton:draw-indicator property.
- */
-gboolean
-gtk_check_button_get_draw_indicator (GtkCheckButton *check_button)
-{
- GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (check_button);
-
- g_return_val_if_fail (GTK_IS_CHECK_BUTTON (check_button), FALSE);
-
- return priv->draw_indicator;
-}
-
/**
* gtk_check_button_set_inconsistent:
* @check_button: a #GtkCheckButton
priv->inconsistent = inconsistent;
if (inconsistent)
- gtk_widget_set_state_flags (GTK_WIDGET (check_button), GTK_STATE_FLAG_INCONSISTENT, FALSE);
+ {
+ gtk_widget_set_state_flags (GTK_WIDGET (check_button), GTK_STATE_FLAG_INCONSISTENT, FALSE);
+ gtk_widget_set_state_flags (priv->indicator_widget, GTK_STATE_FLAG_INCONSISTENT, FALSE);
+ }
else
- gtk_widget_unset_state_flags (GTK_WIDGET (check_button), GTK_STATE_FLAG_INCONSISTENT);
+ {
+ gtk_widget_unset_state_flags (GTK_WIDGET (check_button), GTK_STATE_FLAG_INCONSISTENT);
+ gtk_widget_unset_state_flags (priv->indicator_widget, GTK_STATE_FLAG_INCONSISTENT);
+ }
update_accessible_state (check_button);
* @check_button: a #GtkCheckButton
*
* Returns whether the check button is in an inconsistent state.
- *
+ *
* Returns: %TRUE if @check_button is currently in an 'in between' state, %FALSE otherwise.
*/
gboolean
return priv->inconsistent;
}
+
+/**
+ * gtk_check_button_get_active:
+ * @self: a #GtkCheckButton
+ *
+ * Returns the current value of the #GtkCheckButton:active property.
+ *
+ * Returns: The value of the #GtkCheckButton:active property.
+ * See gtk_check_button_set_active() for details on how to set a new value.
+ */
+gboolean
+gtk_check_button_get_active (GtkCheckButton *self)
+{
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+
+ g_return_val_if_fail (GTK_IS_CHECK_BUTTON (self), FALSE);
+
+ return priv->active;
+}
+
+/**
+ * gtk_check_button_set_active:
+ * @self: a #GtkCheckButton
+ * @setting: the new value to set
+ *
+ * Sets the new value of the #GtkCheckButton:active property.
+ * See also gtk_check_button_get_active().
+ *
+ * Setting #GtkCheckButton:active to %TRUE will add the `:checked:` state to
+ * both the checkbutton and the indicator CSS node.
+ */
+void
+gtk_check_button_set_active (GtkCheckButton *self,
+ gboolean setting)
+{
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+
+ g_return_if_fail (GTK_IS_CHECK_BUTTON (self));
+
+ setting = !!setting;
+
+ if (setting == priv->active)
+ return;
+
+ if (setting)
+ {
+ gtk_widget_set_state_flags (GTK_WIDGET (self), GTK_STATE_FLAG_CHECKED, FALSE);
+ gtk_widget_set_state_flags (priv->indicator_widget, GTK_STATE_FLAG_CHECKED, FALSE);
+ }
+ else
+ {
+ gtk_widget_unset_state_flags (GTK_WIDGET (self), GTK_STATE_FLAG_CHECKED);
+ gtk_widget_unset_state_flags (priv->indicator_widget, GTK_STATE_FLAG_CHECKED);
+ }
+
+ if (setting && (priv->group_prev || priv->group_next))
+ {
+ GtkCheckButton *group_first = NULL;
+ GtkCheckButton *iter;
+
+ /* Find first in group */
+ iter = self;
+ while (iter)
+ {
+ group_first = iter;
+
+ iter = get_group_prev (iter);
+ if (!iter)
+ break;
+ }
+
+ g_assert (group_first);
+
+ /* Set all buttons in group to !active */
+ for (iter = group_first; iter; iter = get_group_next (iter))
+ gtk_check_button_set_active (iter, FALSE);
+
+ /* ... and the next code block will set this one to active */
+ }
+
+ priv->active = setting;
+ update_accessible_state (self);
+ g_object_notify_by_pspec (G_OBJECT (self), props[PROP_ACTIVE]);
+ g_signal_emit (self, signals[TOGGLED], 0);
+}
+
+/**
+ * gtk_check_button_get_label:
+ * @self: a #GtkCheckButton
+ *
+ * Returns the label of the checkbutton.
+ *
+ * Returns: (nullable) (transfer none): The label @self shows next to the indicator.
+ * If no label is shown, %NULL will be returned.
+ */
+const char *
+gtk_check_button_get_label (GtkCheckButton *self)
+{
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+
+ g_return_val_if_fail (GTK_IS_CHECK_BUTTON (self), "");
+
+ if (priv->label_widget)
+ return gtk_label_get_label (GTK_LABEL (priv->label_widget));
+
+ return NULL;
+}
+
+/**
+ * gtk_check_button_set_label:
+ * @self: a #GtkCheckButton
+ * @label: (nullable): The text shown next to the indicator, or %NULL
+ * to show no text
+ *
+ * Sets the text of @self. If #GtkCheckButton:use-underline is %TRUE,
+ * the underscore in @label is interpreted as mnemonic indicator,
+ * see gtk_check_button_set_use_underline() for details on this behavior.
+ *
+ */
+void
+gtk_check_button_set_label (GtkCheckButton *self,
+ const char *label)
+{
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+
+ g_return_if_fail (GTK_IS_CHECK_BUTTON (self));
+
+ if (label == NULL || label[0] == '\0')
+ {
+ g_clear_pointer (&priv->label_widget, gtk_widget_unparent);
+ gtk_widget_remove_css_class (GTK_WIDGET (self), "text-button");
+ }
+ else
+ {
+ if (!priv->label_widget)
+ {
+ priv->label_widget = gtk_label_new (NULL);
+ gtk_widget_set_hexpand (priv->label_widget, TRUE);
+ gtk_label_set_xalign (GTK_LABEL (priv->label_widget), 0.0f);
+ gtk_label_set_use_underline (GTK_LABEL (priv->label_widget), priv->use_underline);
+ gtk_widget_insert_after (priv->label_widget, GTK_WIDGET (self), priv->indicator_widget);
+ }
+ gtk_widget_add_css_class (GTK_WIDGET (self), "text-button");
+ gtk_label_set_label (GTK_LABEL (priv->label_widget), label);
+ }
+
+ gtk_accessible_update_property (GTK_ACCESSIBLE (self),
+ GTK_ACCESSIBLE_PROPERTY_LABEL, label,
+ -1);
+
+ g_object_notify_by_pspec (G_OBJECT (self), props[PROP_LABEL]);
+}
+
+/**
+ * gtk_check_button_set_group:
+ * @self: a #GtkCheckButton
+ * @group: (nullable) (transfer none): another #GtkCheckButton to
+ * form a group with
+ *
+ * Adds @self to the group of @group. In a group of multiple check buttons,
+ * only one button can be active at a time.
+ *
+ * Setting the group of a check button also changes the css name of the
+ * indicator widget's CSS node to 'radio'.
+ *
+ * The behavior of a checkbutton in a group is also commonly known as a 'radio button'.
+ */
+void
+gtk_check_button_set_group (GtkCheckButton *self,
+ GtkCheckButton *group)
+{
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+ GtkCheckButtonPrivate *group_priv = gtk_check_button_get_instance_private (group);
+
+ g_return_if_fail (GTK_IS_CHECK_BUTTON (self));
+
+ if (!group)
+ {
+ if (priv->group_prev)
+ {
+ GtkCheckButtonPrivate *p = gtk_check_button_get_instance_private (priv->group_prev);
+ p->group_next = priv->group_next;
+ }
+ if (priv->group_next)
+ {
+ GtkCheckButtonPrivate *p = gtk_check_button_get_instance_private (priv->group_next);
+ p->group_prev = priv->group_prev;
+ }
+
+ priv->group_next = NULL;
+ priv->group_prev = NULL;
+ g_object_notify_by_pspec (G_OBJECT (self), props[PROP_GROUP]);
+
+ if (priv->indicator_widget)
+ gtk_css_node_set_name (gtk_widget_get_css_node (priv->indicator_widget),
+ g_quark_from_static_string("check"));
+
+ return;
+ }
+
+ if (priv->group_next == group)
+ return;
+
+ priv->group_prev = NULL;
+ if (group_priv->group_prev)
+ {
+ GtkCheckButtonPrivate *prev = gtk_check_button_get_instance_private (group_priv->group_prev);
+
+ prev->group_next = self;
+ priv->group_prev = group_priv->group_prev;
+ }
+
+ group_priv->group_prev = self;
+ priv->group_next = group;
+
+ if (priv->indicator_widget)
+ gtk_css_node_set_name (gtk_widget_get_css_node (priv->indicator_widget),
+ g_quark_from_static_string("radio"));
+
+ gtk_css_node_set_name (gtk_widget_get_css_node (group_priv->indicator_widget),
+ g_quark_from_static_string("radio"));
+
+ g_object_notify_by_pspec (G_OBJECT (self), props[PROP_GROUP]);
+}
+
+/**
+ * gtk_check_button_get_use_underline:
+ * @self: a #GtkCheckButton
+ *
+ * Returns the current value of the #GtkCheckButton:use-underline property.
+ *
+ * Returns: The value of the #GtkCheckButton:use-underline property.
+ * See gtk_check_button_set_use_underline() for details on how to set a new value.
+ */
+gboolean
+gtk_check_button_get_use_underline (GtkCheckButton *self)
+{
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+
+ g_return_val_if_fail (GTK_IS_CHECK_BUTTON (self), FALSE);
+
+ return priv->use_underline;
+}
+
+/**
+ * gtk_check_button_set_use_underline:
+ * @self: a #GtkCheckButton
+ * @setting: the new value to set
+ *
+ * Sets the new value of the #GtkCheckButton:use-underline property.
+ * See also gtk_check_button_get_use_underline().
+ *
+ * If @setting is %TRUE, an underscore character in @self's label indicates
+ * a mnemonic accelerator key. This behavior is similar to #GtkLabel:use-underline.
+ */
+void
+gtk_check_button_set_use_underline (GtkCheckButton *self,
+ gboolean setting)
+{
+ GtkCheckButtonPrivate *priv = gtk_check_button_get_instance_private (self);
+
+ g_return_if_fail (GTK_IS_CHECK_BUTTON (self));
+
+ setting = !!setting;
+
+ if (setting == priv->use_underline)
+ return;
+
+ priv->use_underline = setting;
+ if (priv->label_widget)
+ gtk_label_set_use_underline (GTK_LABEL (priv->label_widget), priv->use_underline);
+
+ g_object_notify_by_pspec (G_OBJECT (self), props[PROP_USE_UNDERLINE]);
+}
#include "gtkradiobutton.h"
#include "gtkwidgetprivate.h"
-#include "gtkcheckbuttonprivate.h"
#include "gtklabel.h"
#include "gtkmarshalers.h"
#include "gtkprivate.h"
* @Title: GtkRadioButton
* @See_also: #GtkComboBox
*
- * A single radio button performs the same basic function as a #GtkCheckButton,
+ * A single radio button performs the same basic function as a #GtkToggleButton,
* as its position in the object hierarchy reflects. It is only when multiple
* radio buttons are grouped together that they become a different user
* interface component in their own right.
struct _GtkRadioButton
{
- GtkCheckButton parent_instance;
+ GtkToggleButton parent_instance;
};
struct _GtkRadioButtonClass
{
- GtkCheckButtonClass parent_class;
+ GtkToggleButtonClass parent_class;
void (*group_changed) (GtkRadioButton *radio_button);
};
static guint signals[N_SIGNALS] = { 0 };
static void gtk_radio_button_dispose (GObject *object);
-static gboolean gtk_radio_button_focus (GtkWidget *widget,
- GtkDirectionType direction);
static void gtk_radio_button_clicked (GtkButton *button);
-static void gtk_radio_button_set_property (GObject *object,
- guint prop_id,
- const GValue *value,
- GParamSpec *pspec);
-static void gtk_radio_button_get_property (GObject *object,
- guint prop_id,
- GValue *value,
- GParamSpec *pspec);
-G_DEFINE_TYPE_WITH_PRIVATE (GtkRadioButton, gtk_radio_button, GTK_TYPE_CHECK_BUTTON)
+G_DEFINE_TYPE_WITH_PRIVATE (GtkRadioButton, gtk_radio_button, GTK_TYPE_TOGGLE_BUTTON)
+
+static void
+gtk_radio_button_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ GtkRadioButton *radio_button;
+
+ radio_button = GTK_RADIO_BUTTON (object);
+
+ switch (prop_id)
+ {
+ GSList *slist;
+ GtkRadioButton *button;
+
+ case PROP_GROUP:
+ button = g_value_get_object (value);
+
+ if (button)
+ slist = gtk_radio_button_get_group (button);
+ else
+ slist = NULL;
+ gtk_radio_button_set_group (radio_button, slist);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+gtk_radio_button_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ switch (prop_id)
+ {
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
static void
gtk_radio_button_class_init (GtkRadioButtonClass *class)
g_object_class_install_properties (gobject_class, LAST_PROP, radio_button_props);
- widget_class->focus = gtk_radio_button_focus;
-
button_class->clicked = gtk_radio_button_clicked;
class->group_changed = NULL;
NULL,
G_TYPE_NONE, 0);
- gtk_widget_class_set_css_name (widget_class, I_("radiobutton"));
gtk_widget_class_set_accessible_role (widget_class, GTK_ACCESSIBLE_ROLE_RADIO);
}
{
GtkRadioButtonPrivate *priv = gtk_radio_button_get_instance_private (self);
GtkWidget *widget = GTK_WIDGET (self);
- GtkCssNode *css_node;
gtk_widget_set_receives_default (widget, FALSE);
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (self), TRUE);
priv->group = g_slist_prepend (NULL, self);
-
- css_node = gtk_widget_get_css_node (widget);
- gtk_css_node_set_name (css_node, g_quark_from_static_string ("radiobutton"));
- css_node = gtk_check_button_get_indicator_node (GTK_CHECK_BUTTON (self));
- gtk_css_node_set_name (css_node, g_quark_from_static_string ("radio"));
-}
-
-static void
-gtk_radio_button_set_property (GObject *object,
- guint prop_id,
- const GValue *value,
- GParamSpec *pspec)
-{
- GtkRadioButton *radio_button;
-
- radio_button = GTK_RADIO_BUTTON (object);
-
- switch (prop_id)
- {
- GSList *slist;
- GtkRadioButton *button;
-
- case PROP_GROUP:
- button = g_value_get_object (value);
-
- if (button)
- slist = gtk_radio_button_get_group (button);
- else
- slist = NULL;
- gtk_radio_button_set_group (radio_button, slist);
- break;
- default:
- G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
- break;
- }
-}
-
-static void
-gtk_radio_button_get_property (GObject *object,
- guint prop_id,
- GValue *value,
- GParamSpec *pspec)
-{
- switch (prop_id)
- {
- default:
- G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
- break;
- }
}
/**
G_OBJECT_CLASS (gtk_radio_button_parent_class)->dispose (object);
}
-static gboolean
-gtk_radio_button_focus (GtkWidget *widget,
- GtkDirectionType direction)
-{
- GtkRadioButton *radio_button = GTK_RADIO_BUTTON (widget);
- GtkRadioButtonPrivate *priv = gtk_radio_button_get_instance_private (radio_button);
- GSList *tmp_slist;
- GtkRadioButton *selected_button = NULL;
-
- /* Radio buttons with draw_indicator unset focus "normally", since
- * they look like buttons to the user.
- */
- if (!gtk_check_button_get_draw_indicator (GTK_CHECK_BUTTON (widget)))
- return GTK_WIDGET_CLASS (gtk_radio_button_parent_class)->focus (widget, direction);
-
- /* Find the currently active button in the group */
- tmp_slist = priv->group;
- while (tmp_slist)
- {
- if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (tmp_slist->data)) &&
- gtk_widget_get_visible (tmp_slist->data))
- selected_button = tmp_slist->data;
- tmp_slist = tmp_slist->next;
- }
-
- if (gtk_widget_is_focus (widget))
- {
- GPtrArray *child_array;
- GtkWidget *new_focus = NULL;
- GSList *l;
- guint index;
- gboolean found;
- guint i;
-
- if (direction == GTK_DIR_TAB_FORWARD ||
- direction == GTK_DIR_TAB_BACKWARD)
- return FALSE;
-
- child_array = g_ptr_array_sized_new (g_slist_length (priv->group));
- for (l = priv->group; l; l = l->next)
- g_ptr_array_add (child_array, l->data);
-
- gtk_widget_focus_sort (widget, direction, child_array);
- found = g_ptr_array_find (child_array, widget, &index);
-
- if (found)
- {
- /* Start at the *next* widget in the list */
- if (index < child_array->len - 1)
- index ++;
- }
- else
- {
- /* Search from the start of the list */
- index = 0;
- }
-
- for (i = index; i < child_array->len; i ++)
- {
- GtkWidget *child = g_ptr_array_index (child_array, i);
-
- if (gtk_widget_get_mapped (child) && gtk_widget_is_sensitive (child))
- {
- new_focus = child;
- break;
- }
- }
-
-
- if (new_focus)
- {
- gtk_widget_grab_focus (new_focus);
- gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (new_focus), TRUE);
- if (selected_button && selected_button != (GtkRadioButton *)new_focus)
- gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (selected_button), FALSE);
- }
-
- g_ptr_array_free (child_array, TRUE);
- return TRUE;
- }
- else
- {
- if (selected_button && selected_button != radio_button)
- return FALSE;
-
- gtk_widget_grab_focus (widget);
- return TRUE;
- }
-}
-
static void
gtk_radio_button_clicked (GtkButton *button)
{